Product Offering API
How to use the API
Here’s an overview of the features included in this API, what they do and what you can use them for.
| API Feature | What it does | What it’s used for |
|---|---|---|
| Get API Version | Retrieves the full version number of the API. | Viewing the API version. |
| Get Product Offers by Query – Place ID | Retrieves a list of available product offers at an address or location. | Obtaining all possible product offers that can be provisioned for your customer. |
| Get Product Offers by Query – Segment name and Place ID | Retrieves a list of available product offers at an address or location filtered by segment name. | Obtaining all possible product offers that can be provisioned for your customer and filtering by segment. |
| Get Product Offers by Query – Offer type and Place ID | Retrieves a list of available product offers at an address or location filtered by offer type. | Obtaining all possible product offers that can be provisioned for your customer and filtering by offer. |
| Get Product Offers by Query – Product family and Place ID | Retrieves a list of available product offers at an address or location filtered by product family. | Obtaining all possible product offers that can be provisioned for your customer and filtering by family. |
Market segment, offer and product family types
The following market segment, offer and product family types are used to retrieve available product offers for an address or location.
Market segment types
Market segment types are the market offer segment designation of the product offering. They are used to retrieve a list of available product offers at an address or location filtered by segment name.
Note: These types are not the dwelling or premises type for the location.
| Market segment type | Description |
|---|---|
| Residential | Intended for use within residential scenarios. |
| Business | Intended for use within small medium enterprise (SME), premium business scenarios. |
| Education | Intended for use within education scenarios. |
Offer types
The offer type is the product family name of the product offer. This is used to retrieve a list of available product offers at an address or location filtered by offer type.
| Offer type | Description |
|---|---|
| Primary | Primary product offers available at an address. |
| Secondary | Secondary product offers at an address. |
Product family types
The product family type is the product family name of the product offer. This is used to retrieve a list of available product offers at an address or location filtered by product family.
| Product family type | Description |
|---|---|
| Bitstream | Bitstream product family offers available at the address. |
| PONFAS Distribution | PONFAS Distribution product family offers available at the address. |